From d345ada58971822cd5ec310ef0a019f0629de1af Mon Sep 17 00:00:00 2001 From: "Daniel Campoverde [alx741]" Date: Mon, 16 May 2016 18:47:55 -0500 Subject: [PATCH] Use dedicated directory for man pages --- Makefile.in | 2 +- src/etc/cargo-build.1 | 89 ------------------ src/etc/cargo.1 | 124 ------------------------- src/etc/man/cargo-build.1 | 127 ++++++++++++++++++++++++++ src/etc/man/cargo.1 | 186 ++++++++++++++++++++++++++++++++++++++ 5 files changed, 314 insertions(+), 214 deletions(-) delete mode 100644 src/etc/cargo-build.1 delete mode 100644 src/etc/cargo.1 create mode 100644 src/etc/man/cargo-build.1 create mode 100644 src/etc/man/cargo.1 diff --git a/Makefile.in b/Makefile.in index 96e960364..d48083043 100644 --- a/Makefile.in +++ b/Makefile.in @@ -280,7 +280,7 @@ prepare-image-$(1): $$(IMGDIR_$(1))/share/zsh/site-functions \ $$(IMGDIR_$(1))/etc/bash_completion.d cp $$(TARGET_$(1))/cargo$$(X) $$(IMGDIR_$(1))/bin - cp $(S)src/etc/*.1 $$(IMGDIR_$(1))/share/man/man1 + cp $(S)src/etc/man/*.1 $$(IMGDIR_$(1))/share/man/man1 cp $(S)src/etc/_cargo $$(IMGDIR_$(1))/share/zsh/site-functions/_cargo cp $(S)src/etc/cargo.bashcomp.sh $$(IMGDIR_$(1))/etc/bash_completion.d/cargo cp $(S)README.md $(S)LICENSE-MIT $(S)LICENSE-APACHE \ diff --git a/src/etc/cargo-build.1 b/src/etc/cargo-build.1 deleted file mode 100644 index 3a07a7fc0..000000000 --- a/src/etc/cargo-build.1 +++ /dev/null @@ -1,89 +0,0 @@ -.TH CARGO\-BUILD "1" "May 2016" "cargo 0.10.0" "Cargo Manual" -.SH NAME -cargo-build \- Compile the current project -.SH SYNOPSIS - -.B cargo build -[\fIOPTIONS\fR] - -.SH DESCRIPTION -This command compiles the current project. - -If the \fB--package\fR argument is given, then \fISPEC\fR is a package id -specification which indicates which package should be built. If it is not given, -then the current package is built. For more information on \fISPEC\fR and its -format, see the `cargo help pkgid` command. - -Compilation can be configured via the use of profiles which are configured in -the manifest. The default profile for this command is `dev`, but passing the -\fB--release\fR flag will use the `release` profile instead. - - -.SH OPTIONS - -.TP -\fB\-h, \-\-help\fR -Print this message -.TP -\fB\-p\fR \fISPEC\fR, \fB\-\-package\fR \fISPEC ...\fR -Package to build -.TP -\fB\-j\fR \fIN\fR, \fB\-\-jobs\fR \fIN\fR -The number of jobs to run in parallel -.TP -\fB\-\-lib\fR -Build only this package's library -.TP -\fB\-\-bin\fR \fINAME\fR -Build only the specified binary -.TP -\fB\-\-example\fR \fINAME\fR -Build only the specified example -.TP -\fB\-\-test\fR \fINAME\fR -Build only the specified test target -.TP -\fB\-\-bench\fR \fINAME\fR -Build only the specified benchmark target -.TP -\fB\-\-release\fR -Build artifacts in release mode, with optimizations -.TP -\fB\-\-features\fR \fIFEATURES\fR -Space-separated list of features to also build -.TP -\fB\-\-no-default-features\fR -Do not build the `default` feature -.TP -\fB\-\-target\fR \fITRIPLE\fR -Build for the target triple -.TP -\fB\-\-manifest-path\fR \fIPATH\fR -Path to the manifest to compile -.TP -\fB\-v, \-\-verbose\fR -Use verbose output -.TP -\fB\-q, \-\-quiet\fR -No output printed to stdout -.TP -\fB\-\-color\fR \fIWHEN\fR -Coloring: auto, always, never - - -.SH "EXAMPLES" -Build a local package and all of its dependencies - $ cargo build - -Build a package with optimizations - $ cargo build --release - - -.SH "SEE ALSO" - -cargo(1) - - -.SH "COPYRIGHT" -This work is dual-licensed under Apache 2.0 and MIT terms. -See \fBCOPYRIGHT\fR file in the cargo source distribution. diff --git a/src/etc/cargo.1 b/src/etc/cargo.1 deleted file mode 100644 index 23b1f331b..000000000 --- a/src/etc/cargo.1 +++ /dev/null @@ -1,124 +0,0 @@ -.TH CARGO "1" "November 2015" "cargo 0.9.0" "User Commands" -.SH NAME -cargo \- The Rust package manager -.SH SYNOPSIS -.B cargo - [...] - -.B cargo -[\fIOPTIONS\fR] - -.SH DESCRIPTION -This program is a package manager for the Rust language, available at -<\fBhttp://rust-lang.org\fR>. - -.SH OPTIONS - -.TP -\fB\-h, \-\-help\fR -Display a help message -.TP -\fB\-V, \-\-version\fR -Print version information and exit -.TP -\fB\-\-list\fR -List all available cargo commands -.TP -\fB\-v, \-\-verbose\fR -Use verbose output -.TP -\fB\-\-color\fR -Configure coloring of output - -.SH COMMANDS - -To get extended information about commands, run 'cargo help ' - -.TP -\fBcargo-build\fR(1) -Compile the current project -.TP -\fBcargo clean\fR -Remove the target directory with build output -.TP -\fBcargo doc\fR -Build this project's and its dependencies' documentation -.TP -\fBcargo init\fR -Create a new cargo project in the current directory -.TP -\fBcargo install\fR -Install a Rust binary -.TP -\fBcargo new\fR -Create a new cargo project -.TP -\fBcargo run\fR -Build and execute src/main.rs -.TP -\fBcargo test\fR -Run the tests for the package -.TP -\fBcargo bench\fR -Run the benchmarks for the package -.TP -\fBcargo update\fR -Update dependencies in Cargo.lock -.TP -\fBcargo rustc\fR -Compile the current project, and optionally pass additional rustc parameters -.TP -\fBcargo package\fR -Generate a source tarball for the current package -.TP -\fBcargo publish\fR -Package and upload this project to the registry -.TP -\fBcargo uninstall\fR -Remove a Rust binary -.TP -\fBcargo search\fR -Search registry for crates -.TP -\fBcargo help\fR -Display help for a cargo command -.TP -\fBcargo version\fR -Print cargo's version and exit - -.SH FILES - -.TP -~/.cargo -Directory in which Cargo stores repository data. Cargo can be instructed to use a .cargo subdirectory in a different location by setting the CARGO_HOME environment variable. - -.SH "EXAMPLES" -Build a local package and all of its dependencies - $ cargo build - -Build a package with optimizations - $ cargo build --release - -Run tests for a cross-compiled target - $ cargo test --target i686-unknown-linux-gnu - -Create a new project that builds an executable - $ cargo new --init foobar - -Create a project in the current directory - $ mkdir foo && cd foo - $ cargo init . - -Learn about a command's options and usage - $ cargo help clean - -.SH "SEE ALSO" - -rustc(1), rustdoc(1) - -.SH "BUGS" -See <\fBhttps://github.com/rust-lang/cargo/issues\fR> for issues. - -.SH "COPYRIGHT" -This work is dual-licensed under Apache 2.0 and MIT terms. See \fBCOPYRIGHT\fR -file in the cargo source distribution. diff --git a/src/etc/man/cargo-build.1 b/src/etc/man/cargo-build.1 new file mode 100644 index 000000000..2b1393b7a --- /dev/null +++ b/src/etc/man/cargo-build.1 @@ -0,0 +1,127 @@ +.TH "CARGO" "1" "May 2016" "The Rust package manager" "Cargo Manual" +.hy +.SH NAME +.PP +cargo\-build \- Compile the current project +.SH SYNOPSIS +.PP +\f[I]cargo build\f[] [OPTIONS] +.SH DESCRIPTION +.PP +This command compiles the current project. +.PP +If the \f[B]\-\-package\f[] argument is given, then \f[I]SPEC\f[] is a +package id specification which indicates which package should be built. +If it is not given, then the current package is built. +For more information on \f[I]SPEC\f[] and its format, see the "cargo +help pkgid" command. +.PP +Compilation can be configured via the use of profiles which are +configured in the manifest. +The default profile for this command is \f[I]dev\f[], but passing the +\f[B]\-\-release\f[] flag will use the \f[I]release\f[] profile instead. +.SH OPTIONS +.TP +.B \-h, \-\-help +Print this message. +.RS +.RE +.TP +.B \-p \f[I]SPEC\f[], \-\-package \f[I]SPEC ...\f[] +Package to build. +.RS +.RE +.TP +.B \-j \f[I]IN\f[], \-\-jobs \f[I]IN\f[] +The number of jobs to run in parallel. +.RS +.RE +.TP +.B \-\-lib +Build only this package\[aq]s library. +.RS +.RE +.TP +.B \-\-bin \f[I]NAME\f[] +Build only the specified binary. +.RS +.RE +.TP +.B \-\-example \f[I]NAME\f[] +Build only the specified example. +.RS +.RE +.TP +.B \-\-test \f[I]NAME\f[] +Build only the specified test target. +.RS +.RE +.TP +.B \-\-bench \f[I]NAME\f[] +Build only the specified benchmark target. +.RS +.RE +.TP +.B \-\-release +Build artifacts in release mode, with optimizations. +.RS +.RE +.TP +.B \-\-features \f[I]FEATURES\f[] +Space\-separated list of features to also build. +.RS +.RE +.TP +.B \-\-no\-default\-features +Do not build the \f[C]default\f[] feature. +.RS +.RE +.TP +.B \-\-target \f[I]TRIPLE\f[] +Build for the target triple. +.RS +.RE +.TP +.B \-\-manifest\-path \f[I]PATH\f[] +Path to the manifest to compile. +.RS +.RE +.TP +.B \-v, \-\-verbose +Use verbose output. +.RS +.RE +.TP +.B \-q, \-\-quiet +No output printed to stdout. +.RS +.RE +.TP +.B \-\-color \f[I]WHEN\f[] +Coloring: auto, always, never. +.RS +.RE +.SH EXAMPLES +.PP +Build a local package and all of its dependencies +.IP +.nf +\f[C] +$\ cargo\ build +\f[] +.fi +.PP +Build a package with optimizations +.IP +.nf +\f[C] +$\ cargo\ build\ \-\-release +\f[] +.fi +.SH SEE ALSO +.PP +cargo(1) +.SH COPYRIGHT +.PP +This work is dual\-licensed under Apache 2.0 and MIT terms. +See \f[I]COPYRIGHT\f[] file in the cargo source distribution. diff --git a/src/etc/man/cargo.1 b/src/etc/man/cargo.1 new file mode 100644 index 000000000..b4b892a04 --- /dev/null +++ b/src/etc/man/cargo.1 @@ -0,0 +1,186 @@ +.TH "CARGO" "1" "May 2016" "The Rust package manager" "Cargo Manual" +.hy +.SH NAME +.PP +cargo \- The Rust package manager +.SH SYNOPSIS +.PP +\f[I]cargo\f[] [...] +.SH DESCRIPTION +.PP +This program is a package manager for the Rust language, available at +. +.SH OPTIONS +.TP +.B \-h, \-\-help +Display a help message. +.RS +.RE +.TP +.B \-V, \-\-version +Print version information and exit. +.RS +.RE +.TP +.B \-\-list +List all available cargo commands. +.RS +.RE +.TP +.B \-v, \-\-verbose +Use verbose output. +.RS +.RE +.TP +.B \-\-color +Configure coloring of output. +.RS +.RE +.SH COMMANDS +.PP +To get extended information about commands, run \f[I]cargo help +\f[] or \f[I]man cargo\-command\f[] +.TP +.B cargo\-build(1) +Compile the current project. +.RS +.RE +.TP +.B cargo\-clean(1) +Remove the target directory with build output. +.RS +.RE +.TP +.B cargo\-doc(1) +Build this project\[aq]s and its dependencies\[aq] documentation. +.RS +.RE +.TP +.B cargo\-init(1) +Create a new cargo project in the current directory. +.RS +.RE +.TP +.B cargo\-install(1) +Install a Rust binary. +.RS +.RE +.TP +.B cargo\-new(1) +Create a new cargo project. +.RS +.RE +.TP +.B cargo\-run(1) +Build and execute src/main.rs. +.RS +.RE +.TP +.B cargo\-test(1) +Run the tests for the package. +.RS +.RE +.TP +.B cargo\-bench(1) +Run the benchmarks for the package. +.RS +.RE +.TP +.B cargo\-update(1) +Update dependencies in Cargo.lock. +.RS +.RE +.TP +.B cargo\-package(1) +Generate a source tarball for the current package. +.RS +.RE +.TP +.B cargo\-publish(1) +Package and upload this project to the registry. +.RS +.RE +.TP +.B cargo\-uninstall(1) +Remove a Rust binary. +.RS +.RE +.TP +.B cargo\-search(1) +Search registry for crates. +.RS +.RE +.TP +.B cargo\-version(1) +Print cargo\[aq]s version and exit. +.RS +.RE +.SH FILES +.TP +.B ~/.cargo +Directory in which Cargo stores repository data. +Cargo can be instructed to use a \f[I]\&.cargo\f[] subdirectory in a +different location by setting the \f[B]CARGO_HOME\f[] environment +variable. +.RS +.RE +.SH EXAMPLES +.PP +Build a local package and all of its dependencies +.IP +.nf +\f[C] +$\ cargo\ build +\f[] +.fi +.PP +Build a package with optimizations +.IP +.nf +\f[C] +$\ cargo\ build\ \-\-release +\f[] +.fi +.PP +Run tests for a cross\-compiled target +.IP +.nf +\f[C] +$\ cargo\ test\ \-\-target\ i686\-unknown\-linux\-gnu +\f[] +.fi +.PP +Create a new project that builds an executable +.IP +.nf +\f[C] +$\ cargo\ new\ \-\-init\ foobar +\f[] +.fi +.PP +Create a project in the current directory +.IP +.nf +\f[C] +$\ mkdir\ foo\ &&\ cd\ foo +$\ cargo\ init\ . +\f[] +.fi +.PP +Learn about a command\[aq]s options and usage +.IP +.nf +\f[C] +$\ cargo\ help\ clean +\f[] +.fi +.SH SEE ALSO +.PP +rustc(1), rustdoc(1) +.SH BUGS +.PP +See for issues. +.SH COPYRIGHT +.PP +This work is dual\-licensed under Apache 2.0 and MIT terms. +See \f[I]COPYRIGHT\f[] file in the cargo source distribution. -- 2.30.2